Add project documentation skill#7
Open
totherush wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add an opt-in
documentationskill that helps agents discover, assess, create, update, verify, and promote durable project documentation without treating.agents/work/as the canonical project knowledge base.The skill:
docs/,doc/, root contribution/security files, generated references, and documentation-site configuration before choosing a location;docs/initialization only when no canonical location exists and the user approves it;Why
Work items already preserve task-local decisions and research, but the project does not currently provide a workflow for turning selected, enduring outcomes into documentation that should guide future unrelated work. This skill adds that promotion path while preserving the existing boundary:
.agents/work/holds task state and work-local context;AGENTS.mdremains a concise map to deeper documentation.The proposed topic tree is guidance rather than mandatory scaffolding. Existing repository conventions always win, and empty topic directories are never created.
Changes
.agents/skills/documentation/SKILL.md.documentationas an upstream core skill, including Claude Code discovery.AGENTS.mdtemplates, skills reference, and changelog.Verification
git diff --checkpasses../scripts/test.shpasses Bash syntax checks and ShellCheck.bats-coreis not installed; CI should execute them.